Retrieve the total size of the data stored in Async Storage

[ziyaddin]

Motivation

In some cases, it is important to know the current total size of the data stored in Async Storage. It would help to predict possible storage issues beforehand due to the storage limit set by React Native authors.

Description

Described in "Motivation" section.

New feature implementation

Possible methods in my mind:

1. Natively (Android API/iOS API) calculate and retrieve the size;
2. Iteratively (via JS) calculate the size of all keys and corresponding values and find the sum.

[gusilveiramp]

It would be great.
Is there already a way to get this information?

[github-actions]

This issue has been marked as stale due to inactivity. Please respond or otherwise resolve the issue within 7 days or it will be closed.

[isidoro98]

@ziyaddin @gusilveiramp I wanted to know the size of storage I was using on iOS, in case you still want to know the code below does the job, you'll just need to expose the native method. It returns the amount of storage used in Bytes

-(NSString *)_getSize
{
    NSString* directory = RCTGetStorageDirectory();
    NSArray *contents = [[NSFileManager defaultManager] contentsOfDirectoryAtPath:directory error:nil];
    NSEnumerator *contentsEnumurator = [contents objectEnumerator];

    NSString *file;
    unsigned long long int folderSize = 0;

    while (file = [contentsEnumurator nextObject]) {
        NSDictionary *fileAttributes = [[NSFileManager defaultManager] attributesOfItemAtPath:[directory stringByAppendingPathComponent:file] error:nil];
        folderSize += [[fileAttributes objectForKey:NSFileSize] intValue];
    }

    NSString *sizeStr = [NSString stringWithFormat:@"%llu", folderSize];
    
    return sizeStr;
}

EDIT:

Also find the code below for Android, as above it returns the storage used in bytes:

File f = new File(mReactDatabaseSupplier.get().getPath());
long dbSize = f.length();

[ferasabufares]

@isidoro98

is there a way to get total size of the data for android ???

[isidoro98]

@isidoro98

is there a way to get total size of the data for android ???

This should do it, based of this SO answer: https://stackoverflow.com/questions/6364577/how-to-get-the-current-sqlite-database-size-or-package-size-in-android/52191503

File f = new File(mReactDatabaseSupplier.get().getPath());
long dbSize = f.length();

[isaachinman]

Anyone have a handy way to do this from the JS side of things?

[krestaino]

@isaachinman I put this together while searching for an answer to this question. It seems to be working well enough.

import AsyncStorage from "@react-native-async-storage/async-storage";
import { Buffer } from "buffer";

function byteLength(obj) {
  return Buffer.byteLength(JSON.stringify(obj));
}

function formatBytes(bytes, decimals = 2) {
  if (!+bytes) return "0 Bytes";

  const k = 1024;
  const dm = decimals < 0 ? 0 : decimals;
  const sizes = ["Bytes", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "ZiB", "YiB"];

  const i = Math.floor(Math.log(bytes) / Math.log(k));

  return `${parseFloat((bytes / Math.pow(k, i)).toFixed(dm))} ${sizes[i]}`;
}

export async function clearStorage() {
  await AsyncStorage.clear();
}

export async function calculateSizes() {
  const keys = await AsyncStorage.getAllKeys();
  console.info("Total keys in AsyncStorage:", keys.length);

  let totalSizeInBytes = 0;

  for (const key of keys) {
    try {
      const item = await AsyncStorage.getItem(key);
      if (item) {
        const sizeInBytes = byteLength(JSON.parse(item));
        console.info(`${key} (${formatBytes(sizeInBytes)})`);
        totalSizeInBytes += sizeInBytes;
      }
    } catch (error) {
      console.error(`Error reading '${key}' from AsyncStorage: ${error.message}`);
    }
  }

  console.info(`Total size of all keys: ${formatBytes(totalSizeInBytes)}`);
}

And then in your root component:

import { registerRootComponent } from "expo";
import App from "./App";

import { calculateSizes, clearStorage } from "./utilities/asyncStorage";

calculateSizes();
// clearStorage(); // https://react-native-async-storage.github.io/async-storage/docs/api/#clear

export default registerRootComponent(App);

[usamaster]

import AsyncStorage from '@react-native-async-storage/async-storage';
import { KeyValuePair } from '@react-native-async-storage/async-storage/lib/typescript/types';

const getAllKeys = async (): Promise<readonly string[]> => {
  let keys: readonly string[] = [];

  try {
    keys = await AsyncStorage.getAllKeys();
  } catch (e) {
    // read key error
  }

  return keys;
};

const getMultiple = async (keys: readonly string[]): Promise<readonly KeyValuePair[]> => {
  let values;

  try {
    values = await AsyncStorage.multiGet(keys);
  } catch (e) {
    // read error
  }

  return values ?? [];
};


export const getSizeOfLocalStorage = async () => {
  const keys = await getAllKeys();
  const values = await getMultiple(keys);
  const size = values.reduce((acc, curr) => acc + (curr[1]?.length ?? 0), 0);

  return size;
};

You can use getmultiple instead of a for loop to get size of the current localstorage