Test_Project_Cocos/cocos-creator-multiplayer
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

sessioin-and-cookie example

Browse Source
This commit is contained in:
King Wang 2021-06-14 17:45:11 +08:00
parent 5af32e67ba
commit 54c2f31f83
28 changed files with 297 additions and 233 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
examples/session-and-cookie/backend/package.json
View File

@ -12,12 +12,14 @@
},
"devDependencies": {
"@types/node": "^15.12.2",
"@types/uuid": "^8.3.0",
"onchange": "^7.1.0",
"ts-node": "^9.1.1",
"tsrpc-cli": "^2.0.1-dev.11",
"typescript": "^4.3.2"
},
"dependencies": {
"tsrpc": "^3.0.0-dev.19"
"tsrpc": "^3.0.0-dev.19",
"uuid": "^8.3.2"
}
}

3
examples/session-and-cookie/backend/src/api/ApiClear.ts
View File

@ -3,7 +3,6 @@ import { ReqClear, ResClear } from "../shared/protocols/PtlClear";
export async function ApiClear(call: ApiCall<ReqClear, ResClear>) {
call.succ({
__cookie: {},
__session: {}
__cookie: {}
})
}

13
examples/session-and-cookie/backend/src/api/ApiGetCookie.ts
View File

@ -1,13 +0,0 @@
import { ApiCall } from "tsrpc";
import { ReqGetCookie, ResGetCookie } from "../shared/protocols/PtlGetCookie";
let times = 0;
export async function ApiGetCookie(call: ApiCall<ReqGetCookie, ResGetCookie>) {
call.succ({
__cookie: {
...call.req.__cookie,
testCookie: 'Cookie ' + (++times),
}
})
}

13
examples/session-and-cookie/backend/src/api/ApiGetSession.ts
View File

@ -1,13 +0,0 @@
import { ApiCall } from "tsrpc";
import { ReqGetSession, ResGetSession } from "../shared/protocols/PtlGetSession";
let times = 0;
export async function ApiGetSession(call: ApiCall<ReqGetSession, ResGetSession>) {
call.succ({
__session: {
...call.req.__session,
testSession: 'Session ' + (++times)
}
})
}

14
examples/session-and-cookie/backend/src/api/ApiSetCookie.ts Normal file
View File

@ -0,0 +1,14 @@
import { ApiCall } from "tsrpc";
import { ReqSetCookie, ResSetCookie } from "../shared/protocols/PtlSetCookie";
let times = 0;
export async function ApiSetCookie(call: ApiCall<ReqSetCookie, ResSetCookie>) {
++times;
call.succ({
__cookie: {
...call.req.__cookie,
testCookie: 'Cookie ' + times,
}
})
}

10
examples/session-and-cookie/backend/src/api/ApiSetSession.ts Normal file
View File

@ -0,0 +1,10 @@
import { ApiCall } from "tsrpc";
import { ReqSetSession, ResSetSession } from "../shared/protocols/PtlSetSession";
let times = 0;
export async function ApiSetSession(call: ApiCall<ReqSetSession, ResSetSession>) {
++times;
await call.setSession('testSession', 'Session ' + times);
call.succ({})
}

5
examples/session-and-cookie/backend/src/api/ApiTest.ts
View File

@ -2,5 +2,8 @@ import { ApiCall } from "tsrpc";
import { ReqTest, ResTest } from "../shared/protocols/PtlTest";
export async function ApiTest(call: ApiCall<ReqTest, ResTest>) {
call.succ({});
let testSession = await call.getSession('testSession');
call.succ({
testSession: testSession
});
}

18
examples/session-and-cookie/backend/src/index.ts
View File

@ -1,6 +1,7 @@
import * as path from "path";
import { HttpServer } from "tsrpc";
import { BaseRequest, BaseResponse } from "./shared/protocols/base";
import { enableCookie } from "./models/enableCookie";
import { ServerSession } from "./models/ServerSession";
import { serviceProto } from "./shared/protocols/serviceProto";
// Create the Server
@ -9,16 +10,11 @@ const server = new HttpServer(serviceProto, {
cors: '*'
});
// Return session and cookie as they are, except reset by res
server.flows.preApiReturnFlow.push(v => {
if (v.return.isSucc) {
let req = v.call.req as BaseRequest;
let res = v.return.res as BaseResponse;
res.__session = res.__session ?? req.__session;
res.__cookie = res.__cookie ?? req.__cookie;
}
return v;
});
// Enable Cookie
enableCookie(server);
// Enable Session
new ServerSession().enable(server);
// Entry function
async function main() {

68
examples/session-and-cookie/backend/src/models/ServerSession.ts Normal file
View File

@ -0,0 +1,68 @@
import { HttpServer } from "tsrpc";
import * as uuid from "uuid";
import { BaseRequest } from "../shared/protocols/base";
// This example store session data to memory for convinience.
// You can store it into database or redis as you need.
export class ServerSession {
async enable(server: HttpServer) {
server.flows.preApiCallFlow.push(async v => {
// Init Session
let req = v.req as BaseRequest;
let { sessionId } = await this.initSession(req.__cookie?.sessionId)
req.__cookie = {
...req.__cookie,
sessionId: sessionId
}
// ApiCall: Get & Set Session
v.getSession = this.getSession.bind(this, sessionId);
v.setSession = this.setSession.bind(this, sessionId);
return v;
});
}
// Test session storage
private _sessionData: {
[sessionId: string]: SessionData;
} = {};
// Storage in server memory for test
// You can modify it to storage into redis / database...
async initSession(sessionId?: string) {
// Existed sessionId
if (sessionId) {
if (this._sessionData[sessionId]) {
return {
sessionId: sessionId
}
}
}
sessionId = uuid.v4();
this._sessionData[sessionId] = {};
return {
sessionId: sessionId
};
}
async getSession<T extends keyof SessionData>(sessioinId: string, key: T): Promise<SessionData[T]> {
return this._sessionData[sessioinId][key];
}
async setSession<T extends keyof SessionData>(sessioinId: string, key: T, value: SessionData[T]): Promise<void> {
this._sessionData[sessioinId][key] = value;
}
}
declare module 'tsrpc' {
export interface ApiCall {
getSession: <T extends keyof SessionData>(key: T) => Promise<SessionData[T]>,
setSession: <T extends keyof SessionData>(key: T, value: SessionData[T]) => Promise<void>
}
}
// Your custom session type definition
export interface SessionData {
testSession?: string
}

14
examples/session-and-cookie/backend/src/models/enableCookie.ts Normal file
View File

@ -0,0 +1,14 @@
import { HttpServer } from "tsrpc";
import { BaseRequest, BaseResponse, Cookie } from "../shared/protocols/base";
export async function enableCookie(server: HttpServer) {
server.flows.preApiReturnFlow.push(v => {
if (v.return.isSucc) {
let req = v.call.req as BaseRequest;
let res = v.return.res as BaseResponse;
// Reset by API handler, or return as they are in the request
res.__cookie = res.__cookie ?? req.__cookie;
}
return v;
});
}

9
examples/session-and-cookie/backend/src/shared/protocols/PtlGetCookie.ts
View File

@ -1,9 +0,0 @@
import { BaseRequest, BaseResponse } from './base'
export interface ReqGetCookie extends BaseRequest {
}
export interface ResGetCookie extends BaseResponse {
}

9
examples/session-and-cookie/backend/src/shared/protocols/PtlGetSession.ts
View File

@ -1,9 +0,0 @@
import { BaseRequest, BaseResponse } from './base'
export interface ReqGetSession extends BaseRequest {
}
export interface ResGetSession extends BaseResponse {
}

9
examples/session-and-cookie/backend/src/shared/protocols/PtlSetCookie.ts Normal file
View File

@ -0,0 +1,9 @@
import { BaseRequest, BaseResponse } from './base'
export interface ReqSetCookie extends BaseRequest {
}
export interface ResSetCookie extends BaseResponse {
}

9
examples/session-and-cookie/backend/src/shared/protocols/PtlSetSession.ts Normal file
View File

@ -0,0 +1,9 @@
import { BaseRequest, BaseResponse } from './base'
export interface ReqSetSession extends BaseRequest {
}
export interface ResSetSession extends BaseResponse {
}

5
examples/session-and-cookie/backend/src/shared/protocols/PtlTest.ts
View File

@ -1,9 +1,10 @@
import { BaseRequest, BaseResponse } from './base'
import { BaseRequest, BaseResponse } from './base';
export interface ReqTest extends BaseRequest {
}
export interface ResTest extends BaseResponse {
// From Session
testSession?: string
}

11
examples/session-and-cookie/backend/src/shared/protocols/base.ts
View File

@ -1,9 +1,12 @@
export interface BaseRequest {
__session?: { [key: string]: any };
__cookie?: { [key: string]: any };
__cookie?: Cookie;
}
export interface BaseResponse {
__session?: { [key: string]: any };
__cookie?: { [key: string]: any };
__cookie?: Cookie;
}
export interface Cookie {
sessionId?: string,
[key: string]: any
}

114
examples/session-and-cookie/backend/src/shared/protocols/serviceProto.ts
View File

@ -1,7 +1,7 @@
import { ServiceProto } from 'tsrpc-proto';
import { ReqClear, ResClear } from './PtlClear';
import { ReqGetCookie, ResGetCookie } from './PtlGetCookie';
import { ReqGetSession, ResGetSession } from './PtlGetSession';
import { ReqSetCookie, ResSetCookie } from './PtlSetCookie';
import { ReqSetSession, ResSetSession } from './PtlSetSession';
import { ReqTest, ResTest } from './PtlTest';
export interface ServiceType {
@ -10,13 +10,13 @@ export interface ServiceType {
req: ReqClear,
res: ResClear
},
"GetCookie": {
req: ReqGetCookie,
res: ResGetCookie
"SetCookie": {
req: ReqSetCookie,
res: ResSetCookie
},
"GetSession": {
req: ReqGetSession,
res: ResGetSession
"SetSession": {
req: ReqSetSession,
res: ResSetSession
},
"Test": {
req: ReqTest,
@ -29,25 +29,24 @@ export interface ServiceType {
}
export const serviceProto: ServiceProto<ServiceType> = {
"version": 3,
"services": [
{
"id": 3,
"id": 0,
"name": "Clear",
"type": "api"
},
{
"id": 0,
"name": "GetCookie",
"type": "api"
},
{
"id": 1,
"name": "GetSession",
"name": "SetCookie",
"type": "api"
},
{
"id": 2,
"name": "SetSession",
"type": "api"
},
{
"id": 3,
"name": "Test",
"type": "api"
}
@ -70,34 +69,34 @@ export const serviceProto: ServiceProto<ServiceType> = {
"properties": [
{
"id": 0,
"name": "__session",
"type": {
"type": "Interface",
"indexSignature": {
"keyType": "String",
"type": {
"type": "Any"
}
}
},
"optional": true
},
{
"id": 1,
"name": "__cookie",
"type": {
"type": "Interface",
"indexSignature": {
"keyType": "String",
"type": {
"type": "Any"
}
}
"type": "Reference",
"target": "base/Cookie"
},
"optional": true
}
]
},
"base/Cookie": {
"type": "Interface",
"properties": [
{
"id": 0,
"name": "sessionId",
"type": {
"type": "String"
},
"optional": true
}
],
"indexSignature": {
"keyType": "String",
"type": {
"type": "Any"
}
}
},
"PtlClear/ResClear": {
"type": "Interface",
"extends": [
@ -115,35 +114,16 @@ export const serviceProto: ServiceProto<ServiceType> = {
"properties": [
{
"id": 0,
"name": "__session",
"type": {
"type": "Interface",
"indexSignature": {
"keyType": "String",
"type": {
"type": "Any"
}
}
},
"optional": true
},
{
"id": 1,
"name": "__cookie",
"type": {
"type": "Interface",
"indexSignature": {
"keyType": "String",
"type": {
"type": "Any"
}
}
"type": "Reference",
"target": "base/Cookie"
},
"optional": true
}
]
},
"PtlGetCookie/ReqGetCookie": {
"PtlSetCookie/ReqSetCookie": {
"type": "Interface",
"extends": [
{
@ -155,7 +135,7 @@ export const serviceProto: ServiceProto<ServiceType> = {
}
]
},
"PtlGetCookie/ResGetCookie": {
"PtlSetCookie/ResSetCookie": {
"type": "Interface",
"extends": [
{
@ -167,7 +147,7 @@ export const serviceProto: ServiceProto<ServiceType> = {
}
]
},
"PtlGetSession/ReqGetSession": {
"PtlSetSession/ReqSetSession": {
"type": "Interface",
"extends": [
{
@ -179,7 +159,7 @@ export const serviceProto: ServiceProto<ServiceType> = {
}
]
},
"PtlGetSession/ResGetSession": {
"PtlSetSession/ResSetSession": {
"type": "Interface",
"extends": [
{
@ -213,6 +193,16 @@ export const serviceProto: ServiceProto<ServiceType> = {
"target": "base/BaseResponse"
}
}
],
"properties": [
{
"id": 0,
"name": "testSession",
"type": {
"type": "String"
},
"optional": true
}
]
}
}

4
examples/session-and-cookie/frontend/public/index.html
View File

@ -15,8 +15,8 @@
<div class="buttons">
<button id="btnTest">Test</button>
<button id="btnClear">Clear</button>
<button id="btnGetSession">Get Session</button>
<button id="btnGetCookie">Get Cookie</button>
<button id="btnSetSession">Set Session</button>
<button id="btnSetCookie">Set Cookie</button>
</div>
<h2>API Request</h2>

12
examples/session-and-cookie/frontend/src/index.ts
View File

@ -1,5 +1,5 @@
import { HttpClient } from 'tsrpc-browser';
import { enableSessionAndCookie } from './models/enableSessionAndCookie';
import { enableCookie } from './models/enableCookie';
import { showReqAndRes } from './models/showReqAndRes';
import { serviceProto } from './shared/protocols/serviceProto';
@ -10,7 +10,7 @@ let client = new HttpClient(serviceProto, {
});
// Session and Cookie
enableSessionAndCookie(client);
enableCookie(client);
// Show Req and Return to View
showReqAndRes(client);
@ -23,9 +23,9 @@ $('#btnTest').onclick = () => {
$('#btnClear').onclick = () => {
client.callApi('Clear', {});
};
$('#btnGetCookie').onclick = () => {
client.callApi('GetCookie', {});
$('#btnSetCookie').onclick = () => {
client.callApi('SetCookie', {});
};
$('#btnGetSession').onclick = () => {
client.callApi('GetSession', {});
$('#btnSetSession').onclick = () => {
client.callApi('SetSession', {});
};

12
examples/session-and-cookie/frontend/src/models/enableSessionAndCookie.ts → examples/session-and-cookie/frontend/src/models/enableCookie.ts
View File

@ -1,19 +1,13 @@
import { HttpClient } from "tsrpc-browser";
const CookieStorageKey = '__MY_COOKIE__';
const SessionStorageKey = '__MY_SESSION__';
export function enableSessionAndCookie(client: HttpClient<any>) {
export function enableCookie(client: HttpClient<any>) {
// Send
client.flows.preCallApiFlow.push(v => {
// Auto get __cookie from localStorage
let cookieStr = localStorage.getItem(CookieStorageKey);
v.req.__cookie = cookieStr ? JSON.parse(cookieStr) : undefined;
// Auto get __session from sessionStorage
let sessionStr = sessionStorage.getItem(SessionStorageKey);
v.req.__session = sessionStr ? JSON.parse(sessionStr) : undefined;
return v;
})
@ -24,10 +18,6 @@ export function enableSessionAndCookie(client: HttpClient<any>) {
if (v.return.res.__cookie) {
localStorage.setItem(CookieStorageKey, JSON.stringify(v.return.res.__cookie))
}
// Auto set __session to sessionStorage
if (v.return.res.__session) {
sessionStorage.setItem(SessionStorageKey, JSON.stringify(v.return.res.__session))
}
}
return v;

8
examples/session-and-cookie/frontend/src/models/showReqAndRes.ts
View File

@ -1,7 +1,13 @@
import { HttpClient } from "tsrpc-browser";
export function showReqAndRes(client: HttpClient<any>) {
// Send
// Clear when send
client.flows.preCallApiFlow.push(v => {
document.querySelector('.apiReq')!.innerHTML = '';
document.querySelector('.apiReturn')!.innerHTML = '';
return v;
});
// Ouput when recv
client.flows.postApiReturnFlow.push(v => {
(document.querySelector('.apiReq') as HTMLElement).innerText = 'callApi: ' + v.apiName + '\n\n' + JSON.stringify(v.req, null, 2);
(document.querySelector('.apiReturn') as HTMLElement).innerText = JSON.stringify(v.return, null, 2);

9
examples/session-and-cookie/frontend/src/shared/protocols/PtlGetCookie.ts
View File

@ -1,9 +0,0 @@
import { BaseRequest, BaseResponse } from './base'
export interface ReqGetCookie extends BaseRequest {
}
export interface ResGetCookie extends BaseResponse {
}

9
examples/session-and-cookie/frontend/src/shared/protocols/PtlGetSession.ts
View File

@ -1,9 +0,0 @@
import { BaseRequest, BaseResponse } from './base'
export interface ReqGetSession extends BaseRequest {
}
export interface ResGetSession extends BaseResponse {
}

9
examples/session-and-cookie/frontend/src/shared/protocols/PtlSetCookie.ts Normal file
View File

@ -0,0 +1,9 @@
import { BaseRequest, BaseResponse } from './base'
export interface ReqSetCookie extends BaseRequest {
}
export interface ResSetCookie extends BaseResponse {
}

9
examples/session-and-cookie/frontend/src/shared/protocols/PtlSetSession.ts Normal file
View File

@ -0,0 +1,9 @@
import { BaseRequest, BaseResponse } from './base'
export interface ReqSetSession extends BaseRequest {
}
export interface ResSetSession extends BaseResponse {
}

5
examples/session-and-cookie/frontend/src/shared/protocols/PtlTest.ts
View File

@ -1,9 +1,10 @@
import { BaseRequest, BaseResponse } from './base'
import { BaseRequest, BaseResponse } from './base';
export interface ReqTest extends BaseRequest {
}
export interface ResTest extends BaseResponse {
// From Session
testSession?: string
}

11
examples/session-and-cookie/frontend/src/shared/protocols/base.ts
View File

@ -1,9 +1,12 @@
export interface BaseRequest {
__session?: { [key: string]: any };
__cookie?: { [key: string]: any };
__cookie?: Cookie;
}
export interface BaseResponse {
__session?: { [key: string]: any };
__cookie?: { [key: string]: any };
__cookie?: Cookie;
}
export interface Cookie {
sessionId?: string,
[key: string]: any
}

114
examples/session-and-cookie/frontend/src/shared/protocols/serviceProto.ts
View File

@ -1,7 +1,7 @@
import { ServiceProto } from 'tsrpc-proto';
import { ReqClear, ResClear } from './PtlClear';
import { ReqGetCookie, ResGetCookie } from './PtlGetCookie';
import { ReqGetSession, ResGetSession } from './PtlGetSession';
import { ReqSetCookie, ResSetCookie } from './PtlSetCookie';
import { ReqSetSession, ResSetSession } from './PtlSetSession';
import { ReqTest, ResTest } from './PtlTest';
export interface ServiceType {
@ -10,13 +10,13 @@ export interface ServiceType {
req: ReqClear,
res: ResClear
},
"GetCookie": {
req: ReqGetCookie,
res: ResGetCookie
"SetCookie": {
req: ReqSetCookie,
res: ResSetCookie
},
"GetSession": {
req: ReqGetSession,
res: ResGetSession
"SetSession": {
req: ReqSetSession,
res: ResSetSession
},
"Test": {
req: ReqTest,
@ -29,25 +29,24 @@ export interface ServiceType {
}
export const serviceProto: ServiceProto<ServiceType> = {
"version": 3,
"services": [
{
"id": 3,
"id": 0,
"name": "Clear",
"type": "api"
},
{
"id": 0,
"name": "GetCookie",
"type": "api"
},
{
"id": 1,
"name": "GetSession",
"name": "SetCookie",
"type": "api"
},
{
"id": 2,
"name": "SetSession",
"type": "api"
},
{
"id": 3,
"name": "Test",
"type": "api"
}
@ -70,34 +69,34 @@ export const serviceProto: ServiceProto<ServiceType> = {
"properties": [
{
"id": 0,
"name": "__session",
"type": {
"type": "Interface",
"indexSignature": {
"keyType": "String",
"type": {
"type": "Any"
}
}
},
"optional": true
},
{
"id": 1,
"name": "__cookie",
"type": {
"type": "Interface",
"indexSignature": {
"keyType": "String",
"type": {
"type": "Any"
}
}
"type": "Reference",
"target": "base/Cookie"
},
"optional": true
}
]
},
"base/Cookie": {
"type": "Interface",
"properties": [
{
"id": 0,
"name": "sessionId",
"type": {
"type": "String"
},
"optional": true
}
],
"indexSignature": {
"keyType": "String",
"type": {
"type": "Any"
}
}
},
"PtlClear/ResClear": {
"type": "Interface",
"extends": [
@ -115,35 +114,16 @@ export const serviceProto: ServiceProto<ServiceType> = {
"properties": [
{
"id": 0,
"name": "__session",
"type": {
"type": "Interface",
"indexSignature": {
"keyType": "String",
"type": {
"type": "Any"
}
}
},
"optional": true
},
{
"id": 1,
"name": "__cookie",
"type": {
"type": "Interface",
"indexSignature": {
"keyType": "String",
"type": {
"type": "Any"
}
}
"type": "Reference",
"target": "base/Cookie"
},
"optional": true
}
]
},
"PtlGetCookie/ReqGetCookie": {
"PtlSetCookie/ReqSetCookie": {
"type": "Interface",
"extends": [
{
@ -155,7 +135,7 @@ export const serviceProto: ServiceProto<ServiceType> = {
}
]
},
"PtlGetCookie/ResGetCookie": {
"PtlSetCookie/ResSetCookie": {
"type": "Interface",
"extends": [
{
@ -167,7 +147,7 @@ export const serviceProto: ServiceProto<ServiceType> = {
}
]
},
"PtlGetSession/ReqGetSession": {
"PtlSetSession/ReqSetSession": {
"type": "Interface",
"extends": [
{
@ -179,7 +159,7 @@ export const serviceProto: ServiceProto<ServiceType> = {
}
]
},
"PtlGetSession/ResGetSession": {
"PtlSetSession/ResSetSession": {
"type": "Interface",
"extends": [
{
@ -213,6 +193,16 @@ export const serviceProto: ServiceProto<ServiceType> = {
"target": "base/BaseResponse"
}
}
],
"properties": [
{
"id": 0,
"name": "testSession",
"type": {
"type": "String"
},
"optional": true
}
]
}
}