Page MenuHomePhabricator
Differential D4318

[lib] Rename generic types in `action-utils` to be more descriptive
ClosedPublic
Actions

Authored by atul on Jun 21 2022, 3:59 PM.
Tags
None
Referenced Files
Unknown Object (File)
Mon, Mar 17, 7:12 PM
Unknown Object (File)
Wed, Mar 12, 10:01 PM
Unknown Object (File)
Tue, Mar 11, 5:39 PM
Unknown Object (File)
Sat, Mar 8, 11:37 AM
Unknown Object (File)
Fri, Mar 7, 1:01 PM
Unknown Object (File)
Thu, Mar 6, 4:14 AM
Unknown Object (File)
Thu, Mar 6, 4:14 AM
Unknown Object (File)
Thu, Mar 6, 4:14 AM
View All Files
Subscribers
• abosh
• adrian
tomek

Details

Reviewers
ashoat
Commits
rCOMM7c34016076ce: [lib] Rename generic types in `action-utils` to be more descriptive
Summary

I personally prefer more descriptive generic type names vs single letter (eg T) generic names. Specifically, I found renaming the generic names in action-utils helped me make sense of what was going on.

I realize this is an "opinionated" change and using single letters for generic type names is common... so very open to abandoning this diff if others disagree.

Test Plan

Flow

Diff Detail

Repository
rCOMM Comm
Branch
june21 (branched from master)
Lint
No Lint Coverage
Unit
No Test Coverage

Revision Contents
Changeset List

PathSize
lib/
utils/
76 lines

Diff 13639

View Options

lib/utils/action-utils.js

syntax = "proto3"; syntax = "proto3";
package identity; package identity;
service IdentityService { service IdentityService {
rpc AuthenticateUser(stream AuthenticationRequest) returns (stream AuthenticationResponse) {} // Called by user to register with the Identity Service (PAKE only)
rpc RegisterUser(stream RegistrationRequest) returns (RegistrationResponse) {}
// Called by user to create an active session and get an access token
rpc LoginUser(stream LoginRequest) returns (LoginResponse) {}
// Called by other services to get a user's token
rpc GetUserToken(GetUserTokenRequest) returns (GetUserTokenResponse) {}
} }
// Helper types // Helper types
message PakeRegistrationRequestAndUserID { message PakeRegistrationRequestAndUserID {
string userID = 1; string userID = 1;
bytes pakeRegistrationRequest = 2; bytes pakeRegistrationRequest = 2;
} }
message PakeAuthenticationRequestData { message pakeCredentialRequestAndUserID {
string userID = 1;
bytes pakeCredentialRequest = 2;
}
message PakeLoginRequest {
oneof data { oneof data {
PakeRegistrationRequestAndUserID pakeRegistrationRequestAndUserID = 1; pakeCredentialRequestAndUserID pakeCredentialRequestAndUserID = 1;
bytes pakeRegistrationUpload = 2; bytes pakeCredentialFinalization = 2;
bytes pakeCredentialRequest = 3;
bytes pakeCredentialFinalization = 4;
bytes pakeClientMAC = 5;
} }
} }
message WalletAuthenticationRequestData { message PakeLoginResponse {
bytes pakeCredentialResponse = 1;
}
message WalletLoginRequest {
string userID = 1; string userID = 1;
string walletAddress = 2; string walletAddress = 2;
bytes signedMessage = 3; bytes signedMessage = 3;
} }
message WalletAuthenticationResponseData { message WalletLoginResponse {
bool success = 1; bytes token = 1;
} }
message PakeAuthenticationResponseData { // RegisterUser
message RegistrationRequest {
oneof data { oneof data {
bytes pakeRegistrationResponse = 1; PakeRegistrationRequestAndUserID pakeRegistrationRequestAndUserID = 1;
bool pakeRegistrationSuccess = 2; bytes pakeRegistrationUpload = 2;
bytes pakeCredentialResponse = 3;
bytes pakeServerMAC = 4;
} }
} }
// AuthenticateUser message RegistrationResponse {
bytes pakeRegistrationResponse = 1;
}
// LoginUser
message AuthenticationRequest { message LoginRequest {
oneof data { oneof data {
PakeAuthenticationRequestData pakeAuthenticationRequestData = 1; PakeLoginRequest pakeLoginRequest = 1;
WalletAuthenticationRequestData walletAuthenticationRequestData = 2; WalletLoginRequest walletLoginRequest = 2;
} }
} }
message AuthenticationResponse { message LoginResponse {
oneof data { oneof data {
PakeAuthenticationResponseData pakeAuthenticationResponseData = 1; PakeLoginResponse pakeLoginResponse = 1;
WalletAuthenticationResponseData walletAuthenticationResponseData = 2; WalletLoginResponse walletLoginResponse = 2;
} }
} }
// GetUserToken
message GetUserTokenRequest {
string userID = 1;
}
message GetUserTokenResponse {
bytes token = 2;
}
/**
* Database - Structure:
* token
* userID[PK] string
* created timestamp
* token bytes
* registrationData bytes
* valid boolean
*/
/**
* Database - Description:
* token - tokens assigned to users along with the data necessary to retrieve
* them
* `created` - when the token was created
* `registrationData` - serialized data described by one of the
* following structures
* { authType: 'password', pakePasswordCiphertext: string }
* { authType: 'wallet', walletAddress: string }
* `valid` - false if the token has been revoked
*/