Page MenuHomePhabricator
Differential D12901

[shared][rust] Add proc-macro to deserialize tagged enum variants
ClosedPublic
Actions

Authored by bartek on Jul 28 2024, 7:12 AM.
Tags
None
Referenced Files
Unknown Object (File)
Sun, Mar 23, 2:00 PM
Unknown Object (File)
Wed, Mar 12, 12:39 AM
Unknown Object (File)
Tue, Mar 11, 10:44 AM
Unknown Object (File)
Tue, Mar 11, 9:37 AM
Unknown Object (File)
Mon, Mar 3, 6:24 AM
Unknown Object (File)
Mon, Mar 3, 6:24 AM
Unknown Object (File)
Fri, Feb 28, 6:05 AM
Unknown Object (File)
Fri, Feb 28, 5:02 AM
View All 71 Files
Subscribers
ashoat
tomek

Details

Reviewers
varun
will
kamil
Commits
rCOMM9463274996c6: [shared][rust] Add proc-macro to deserialize tagged enum variants
Summary

Detailed description of why we need this: ENG-8901.

Unfortunately, proc-macros need to be defined in a separate crate (see why), so I created a util-macros crate in our Cargo workspace.

Test Plan
  • Added rustdoc usage example
  • Rust unit tests added in the next diff
  • Used and tested in in D12895
  • Rust playground - see Linear description

Diff Detail

Repository
rCOMM Comm
Lint
No Lint Coverage
Unit
No Test Coverage

Revision Contents
Changeset List

PathSize
shared/
util_macros/
15 lines
src/
62 lines
41 lines

Diff 42847

View Options

Cargo.lock

Show All 29 Lines
import type { WebNavInfo } from 'lib/types/nav-types.js'; import type { WebNavInfo } from 'lib/types/nav-types.js';
import { cookieTypes } from 'lib/types/session-types.js'; import { cookieTypes } from 'lib/types/session-types.js';
import { defaultConnectionInfo } from 'lib/types/socket-types.js'; import { defaultConnectionInfo } from 'lib/types/socket-types.js';
import { defaultGlobalThemeInfo } from 'lib/types/theme-types.js'; import { defaultGlobalThemeInfo } from 'lib/types/theme-types.js';
import type { ClientDBThreadInfo } from 'lib/types/thread-types.js'; import type { ClientDBThreadInfo } from 'lib/types/thread-types.js';
import { getConfig } from 'lib/utils/config.js'; import { getConfig } from 'lib/utils/config.js';
import { parseCookies } from 'lib/utils/cookie-utils.js'; import { parseCookies } from 'lib/utils/cookie-utils.js';
import { isDev } from 'lib/utils/dev-utils.js'; import { isDev } from 'lib/utils/dev-utils.js';
import { stripMemberPermissionsFromRawThreadInfos } from 'lib/utils/member-info-utils.js';
import { import {
generateIDSchemaMigrationOpsForDrafts, generateIDSchemaMigrationOpsForDrafts,
convertDraftStoreToNewIDSchema, convertDraftStoreToNewIDSchema,
createAsyncMigrate, createAsyncMigrate,
type StorageMigrationFunction, type StorageMigrationFunction,
} from 'lib/utils/migration-utils.js'; } from 'lib/utils/migration-utils.js';
import { entries } from 'lib/utils/objects.js'; import { entries } from 'lib/utils/objects.js';
import { import {
▲ Show 20 Lines • Show All 560 Lines • ▼ Show 20 Lines return {
tunnelbrokerDeviceToken: { tunnelbrokerDeviceToken: {
localToken: null, localToken: null,
tunnelbrokerToken: null, tunnelbrokerToken: null,
}, },
}, },
ops: [], ops: [],
}; };
}, },
[80]: async (state: AppState) => {
// 1. Check if `databaseModule` is supported and early-exit if not.
const sharedWorker = await getCommSharedWorker();
const isDatabaseSupported = await sharedWorker.isSupported();
if (!isDatabaseSupported) {
return {
state,
ops: [],
};
}
// 2. Get existing `stores` from SQLite.
const stores = await sharedWorker.schedule({
type: workerRequestMessageTypes.GET_CLIENT_STORE,
});
const clientDBThreadInfos: ?$ReadOnlyArray<ClientDBThreadInfo> =
stores?.store?.threads;
if (
clientDBThreadInfos === null ||
clientDBThreadInfos === undefined ||
clientDBThreadInfos.length === 0
) {
return {
state,
ops: [],
};
}
const dbOperations = createUpdateDBOpsForThreadStoreThreadInfos(
clientDBThreadInfos,
// We know that we're dealing with `ThinRawThreadInfoWithPermissions`
// at time of this migration.
// $FlowFixMe
ashoatUnsubmitted
Not Done
Inline Actions

Same feedback here as in D12789

ashoat: Same feedback here as in D12789
stripMemberPermissionsFromRawThreadInfos,
);
return {
state,
ops: dbOperations,
};
},
}; };
const persistConfig: PersistConfig = { const persistConfig: PersistConfig = {
keyPrefix: rootKeyPrefix, keyPrefix: rootKeyPrefix,
key: rootKey, key: rootKey,
storage: commReduxStorageEngine, storage: commReduxStorageEngine,
whitelist: isSQLiteSupported() whitelist: isSQLiteSupported()
? persistWhitelist ? persistWhitelist
Show All 14 Lines
View Options

shared/util_macros/Cargo.toml

Show All 29 Lines
import type { WebNavInfo } from 'lib/types/nav-types.js'; import type { WebNavInfo } from 'lib/types/nav-types.js';
import { cookieTypes } from 'lib/types/session-types.js'; import { cookieTypes } from 'lib/types/session-types.js';
import { defaultConnectionInfo } from 'lib/types/socket-types.js'; import { defaultConnectionInfo } from 'lib/types/socket-types.js';
import { defaultGlobalThemeInfo } from 'lib/types/theme-types.js'; import { defaultGlobalThemeInfo } from 'lib/types/theme-types.js';
import type { ClientDBThreadInfo } from 'lib/types/thread-types.js'; import type { ClientDBThreadInfo } from 'lib/types/thread-types.js';
import { getConfig } from 'lib/utils/config.js'; import { getConfig } from 'lib/utils/config.js';
import { parseCookies } from 'lib/utils/cookie-utils.js'; import { parseCookies } from 'lib/utils/cookie-utils.js';
import { isDev } from 'lib/utils/dev-utils.js'; import { isDev } from 'lib/utils/dev-utils.js';
import { stripMemberPermissionsFromRawThreadInfos } from 'lib/utils/member-info-utils.js';
import { import {
generateIDSchemaMigrationOpsForDrafts, generateIDSchemaMigrationOpsForDrafts,
convertDraftStoreToNewIDSchema, convertDraftStoreToNewIDSchema,
createAsyncMigrate, createAsyncMigrate,
type StorageMigrationFunction, type StorageMigrationFunction,
} from 'lib/utils/migration-utils.js'; } from 'lib/utils/migration-utils.js';
import { entries } from 'lib/utils/objects.js'; import { entries } from 'lib/utils/objects.js';
import { import {
▲ Show 20 Lines • Show All 560 Lines • ▼ Show 20 Lines return {
tunnelbrokerDeviceToken: { tunnelbrokerDeviceToken: {
localToken: null, localToken: null,
tunnelbrokerToken: null, tunnelbrokerToken: null,
}, },
}, },
ops: [], ops: [],
}; };
}, },
[80]: async (state: AppState) => {
// 1. Check if `databaseModule` is supported and early-exit if not.
const sharedWorker = await getCommSharedWorker();
const isDatabaseSupported = await sharedWorker.isSupported();
if (!isDatabaseSupported) {
return {
state,
ops: [],
};
}
// 2. Get existing `stores` from SQLite.
const stores = await sharedWorker.schedule({
type: workerRequestMessageTypes.GET_CLIENT_STORE,
});
const clientDBThreadInfos: ?$ReadOnlyArray<ClientDBThreadInfo> =
stores?.store?.threads;
if (
clientDBThreadInfos === null ||
clientDBThreadInfos === undefined ||
clientDBThreadInfos.length === 0
) {
return {
state,
ops: [],
};
}
const dbOperations = createUpdateDBOpsForThreadStoreThreadInfos(
clientDBThreadInfos,
// We know that we're dealing with `ThinRawThreadInfoWithPermissions`
// at time of this migration.
// $FlowFixMe
ashoatUnsubmitted
Not Done
Inline Actions

Same feedback here as in D12789

ashoat: Same feedback here as in D12789
stripMemberPermissionsFromRawThreadInfos,
);
return {
state,
ops: dbOperations,
};
},
}; };
const persistConfig: PersistConfig = { const persistConfig: PersistConfig = {
keyPrefix: rootKeyPrefix, keyPrefix: rootKeyPrefix,
key: rootKey, key: rootKey,
storage: commReduxStorageEngine, storage: commReduxStorageEngine,
whitelist: isSQLiteSupported() whitelist: isSQLiteSupported()
? persistWhitelist ? persistWhitelist
Show All 14 Lines
View Options

shared/util_macros/src/lib.rs

Show All 29 Lines
import type { WebNavInfo } from 'lib/types/nav-types.js'; import type { WebNavInfo } from 'lib/types/nav-types.js';
import { cookieTypes } from 'lib/types/session-types.js'; import { cookieTypes } from 'lib/types/session-types.js';
import { defaultConnectionInfo } from 'lib/types/socket-types.js'; import { defaultConnectionInfo } from 'lib/types/socket-types.js';
import { defaultGlobalThemeInfo } from 'lib/types/theme-types.js'; import { defaultGlobalThemeInfo } from 'lib/types/theme-types.js';
import type { ClientDBThreadInfo } from 'lib/types/thread-types.js'; import type { ClientDBThreadInfo } from 'lib/types/thread-types.js';
import { getConfig } from 'lib/utils/config.js'; import { getConfig } from 'lib/utils/config.js';
import { parseCookies } from 'lib/utils/cookie-utils.js'; import { parseCookies } from 'lib/utils/cookie-utils.js';
import { isDev } from 'lib/utils/dev-utils.js'; import { isDev } from 'lib/utils/dev-utils.js';
import { stripMemberPermissionsFromRawThreadInfos } from 'lib/utils/member-info-utils.js';
import { import {
generateIDSchemaMigrationOpsForDrafts, generateIDSchemaMigrationOpsForDrafts,
convertDraftStoreToNewIDSchema, convertDraftStoreToNewIDSchema,
createAsyncMigrate, createAsyncMigrate,
type StorageMigrationFunction, type StorageMigrationFunction,
} from 'lib/utils/migration-utils.js'; } from 'lib/utils/migration-utils.js';
import { entries } from 'lib/utils/objects.js'; import { entries } from 'lib/utils/objects.js';
import { import {
▲ Show 20 Lines • Show All 560 Lines • ▼ Show 20 Lines return {
tunnelbrokerDeviceToken: { tunnelbrokerDeviceToken: {
localToken: null, localToken: null,
tunnelbrokerToken: null, tunnelbrokerToken: null,
}, },
}, },
ops: [], ops: [],
}; };
}, },
[80]: async (state: AppState) => {
// 1. Check if `databaseModule` is supported and early-exit if not.
const sharedWorker = await getCommSharedWorker();
const isDatabaseSupported = await sharedWorker.isSupported();
if (!isDatabaseSupported) {
return {
state,
ops: [],
};
}
// 2. Get existing `stores` from SQLite.
const stores = await sharedWorker.schedule({
type: workerRequestMessageTypes.GET_CLIENT_STORE,
});
const clientDBThreadInfos: ?$ReadOnlyArray<ClientDBThreadInfo> =
stores?.store?.threads;
if (
clientDBThreadInfos === null ||
clientDBThreadInfos === undefined ||
clientDBThreadInfos.length === 0
) {
return {
state,
ops: [],
};
}
const dbOperations = createUpdateDBOpsForThreadStoreThreadInfos(
clientDBThreadInfos,
// We know that we're dealing with `ThinRawThreadInfoWithPermissions`
// at time of this migration.
// $FlowFixMe
ashoatUnsubmitted
Not Done
Inline Actions

Same feedback here as in D12789

ashoat: Same feedback here as in D12789
stripMemberPermissionsFromRawThreadInfos,
);
return {
state,
ops: dbOperations,
};
},
}; };
const persistConfig: PersistConfig = { const persistConfig: PersistConfig = {
keyPrefix: rootKeyPrefix, keyPrefix: rootKeyPrefix,
key: rootKey, key: rootKey,
storage: commReduxStorageEngine, storage: commReduxStorageEngine,
whitelist: isSQLiteSupported() whitelist: isSQLiteSupported()
? persistWhitelist ? persistWhitelist
Show All 14 Lines
View Options

shared/util_macros/src/tag_aware_deserialize.rs

Show All 29 Lines
import type { WebNavInfo } from 'lib/types/nav-types.js'; import type { WebNavInfo } from 'lib/types/nav-types.js';
import { cookieTypes } from 'lib/types/session-types.js'; import { cookieTypes } from 'lib/types/session-types.js';
import { defaultConnectionInfo } from 'lib/types/socket-types.js'; import { defaultConnectionInfo } from 'lib/types/socket-types.js';
import { defaultGlobalThemeInfo } from 'lib/types/theme-types.js'; import { defaultGlobalThemeInfo } from 'lib/types/theme-types.js';
import type { ClientDBThreadInfo } from 'lib/types/thread-types.js'; import type { ClientDBThreadInfo } from 'lib/types/thread-types.js';
import { getConfig } from 'lib/utils/config.js'; import { getConfig } from 'lib/utils/config.js';
import { parseCookies } from 'lib/utils/cookie-utils.js'; import { parseCookies } from 'lib/utils/cookie-utils.js';
import { isDev } from 'lib/utils/dev-utils.js'; import { isDev } from 'lib/utils/dev-utils.js';
import { stripMemberPermissionsFromRawThreadInfos } from 'lib/utils/member-info-utils.js';
import { import {
generateIDSchemaMigrationOpsForDrafts, generateIDSchemaMigrationOpsForDrafts,
convertDraftStoreToNewIDSchema, convertDraftStoreToNewIDSchema,
createAsyncMigrate, createAsyncMigrate,
type StorageMigrationFunction, type StorageMigrationFunction,
} from 'lib/utils/migration-utils.js'; } from 'lib/utils/migration-utils.js';
import { entries } from 'lib/utils/objects.js'; import { entries } from 'lib/utils/objects.js';
import { import {
▲ Show 20 Lines • Show All 560 Lines • ▼ Show 20 Lines return {
tunnelbrokerDeviceToken: { tunnelbrokerDeviceToken: {
localToken: null, localToken: null,
tunnelbrokerToken: null, tunnelbrokerToken: null,
}, },
}, },
ops: [], ops: [],
}; };
}, },
[80]: async (state: AppState) => {
// 1. Check if `databaseModule` is supported and early-exit if not.
const sharedWorker = await getCommSharedWorker();
const isDatabaseSupported = await sharedWorker.isSupported();
if (!isDatabaseSupported) {
return {
state,
ops: [],
};
}
// 2. Get existing `stores` from SQLite.
const stores = await sharedWorker.schedule({
type: workerRequestMessageTypes.GET_CLIENT_STORE,
});
const clientDBThreadInfos: ?$ReadOnlyArray<ClientDBThreadInfo> =
stores?.store?.threads;
if (
clientDBThreadInfos === null ||
clientDBThreadInfos === undefined ||
clientDBThreadInfos.length === 0
) {
return {
state,
ops: [],
};
}
const dbOperations = createUpdateDBOpsForThreadStoreThreadInfos(
clientDBThreadInfos,
// We know that we're dealing with `ThinRawThreadInfoWithPermissions`
// at time of this migration.
// $FlowFixMe
ashoatUnsubmitted
Not Done
Inline Actions

Same feedback here as in D12789

ashoat: Same feedback here as in D12789
stripMemberPermissionsFromRawThreadInfos,
);
return {
state,
ops: dbOperations,
};
},
}; };
const persistConfig: PersistConfig = { const persistConfig: PersistConfig = {
keyPrefix: rootKeyPrefix, keyPrefix: rootKeyPrefix,
key: rootKey, key: rootKey,
storage: commReduxStorageEngine, storage: commReduxStorageEngine,
whitelist: isSQLiteSupported() whitelist: isSQLiteSupported()
? persistWhitelist ? persistWhitelist
Show All 14 Lines