|
| 1 | +// Copyright 2022 Google LLC |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// https://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +package main |
| 16 | + |
| 17 | +import ( |
| 18 | + "fmt" |
| 19 | + "log" |
| 20 | + "sync" |
| 21 | + "time" |
| 22 | + |
| 23 | + "github.com/GoogleCloudPlatform/functions-framework-conformance/events" |
| 24 | +) |
| 25 | + |
| 26 | +func timeExecution(fn func() error) (time.Duration, error) { |
| 27 | + start := time.Now() |
| 28 | + err := fn() |
| 29 | + return time.Since(start), err |
| 30 | +} |
| 31 | + |
| 32 | +// validateConcurrency validates a server can handle concurrent requests by |
| 33 | +// valdating that the response time for a single request does not increase |
| 34 | +// linearly with n concurrent requests, given a function that: |
| 35 | +// 1. Is not CPU-bound (e.g. sleeps) |
| 36 | +// 2. Executes for at least 1s to ensure non-trivial measurement differences |
| 37 | +func validateConcurrency(url string, functionType string) error { |
| 38 | + log.Printf("%s validation with concurrent requests...", functionType) |
| 39 | + var sendFn func() error |
| 40 | + switch functionType { |
| 41 | + case "http": |
| 42 | + sendFn = func() error { |
| 43 | + return sendHTTP(url, []byte(`{"data": "hello"}`)) |
| 44 | + } |
| 45 | + case "cloudevent": |
| 46 | + // Arbitrary payload that conforms to CloudEvent schema |
| 47 | + sendFn = func() error { |
| 48 | + return send(url, events.CloudEvent, []byte(`{ |
| 49 | + "specversion": "1.0", |
| 50 | + "type": "google.firebase.auth.user.v1.created", |
| 51 | + "source": "//firebaseauth.googleapis.com/projects/my-project-id", |
| 52 | + "subject": "users/UUpby3s4spZre6kHsgVSPetzQ8l2", |
| 53 | + "id": "aaaaaa-1111-bbbb-2222-cccccccccccc", |
| 54 | + "time": "2020-09-29T11:32:00.123Z", |
| 55 | + "datacontenttype": "application/json", |
| 56 | + "data": { |
| 57 | + |
| 58 | + "metadata": { |
| 59 | + "createTime": "2020-05-26T10:42:27Z", |
| 60 | + "lastSignInTime": "2020-10-24T11:00:00Z" |
| 61 | + }, |
| 62 | + "providerData": [ |
| 63 | + { |
| 64 | + |
| 65 | + "providerId": "password", |
| 66 | + |
| 67 | + } |
| 68 | + ], |
| 69 | + "uid": "UUpby3s4spZre6kHsgVSPetzQ8l2" |
| 70 | + } |
| 71 | + }`)) |
| 72 | + } |
| 73 | + case "legacyevent": |
| 74 | + // Arbitrary payload that conforms to Background event schema |
| 75 | + sendFn = func() error { |
| 76 | + return send(url, events.LegacyEvent, []byte(`{ |
| 77 | + "data": { |
| 78 | + |
| 79 | + "metadata": { |
| 80 | + "createdAt": "2020-05-26T10:42:27Z", |
| 81 | + "lastSignedInAt": "2020-10-24T11:00:00Z" |
| 82 | + }, |
| 83 | + "providerData": [ |
| 84 | + { |
| 85 | + |
| 86 | + "providerId": "password", |
| 87 | + |
| 88 | + } |
| 89 | + ], |
| 90 | + "uid": "UUpby3s4spZre6kHsgVSPetzQ8l2" |
| 91 | + }, |
| 92 | + "eventId": "aaaaaa-1111-bbbb-2222-cccccccccccc", |
| 93 | + "eventType": "providers/firebase.auth/eventTypes/user.create", |
| 94 | + "notSupported": { |
| 95 | + }, |
| 96 | + "resource": "projects/my-project-id", |
| 97 | + "timestamp": "2020-09-29T11:32:00.123Z" |
| 98 | + }`)) |
| 99 | + } |
| 100 | + default: |
| 101 | + return fmt.Errorf("expected type to be one of 'http', 'cloudevent', or 'legacyevent', got %s", functionType) |
| 102 | + } |
| 103 | + if err := sendConcurrentRequests(sendFn); err != nil { |
| 104 | + return err |
| 105 | + } |
| 106 | + log.Printf("Concurrency validation passed!") |
| 107 | + return nil |
| 108 | +} |
| 109 | + |
| 110 | +func sendConcurrentRequests(sendFn func() error) error { |
| 111 | + // Get a benchmark for the time it takes for a single request |
| 112 | + singleReqTime, singleReqErr := timeExecution(func() error { |
| 113 | + return sendFn() |
| 114 | + }) |
| 115 | + if singleReqErr != nil { |
| 116 | + return fmt.Errorf("concurrent validation unable to send single request to benchmark response time: %v", singleReqErr) |
| 117 | + } |
| 118 | + |
| 119 | + minWait := 1 * time.Second |
| 120 | + if singleReqTime < minWait { |
| 121 | + return fmt.Errorf("concurrent validation requires a function that waits at least %s before responding, function responded in %s", minWait, singleReqTime) |
| 122 | + } |
| 123 | + log.Printf("Single request response time benchmarked, took %s for 1 request", singleReqTime) |
| 124 | + |
| 125 | + // Get a benchmark for the time it takes for concurrent requests |
| 126 | + const numConReqs = 10 |
| 127 | + log.Printf("Starting %d concurrent workers to send requests", numConReqs) |
| 128 | + |
| 129 | + type workerResponse struct { |
| 130 | + id int |
| 131 | + err error |
| 132 | + } |
| 133 | + var wg sync.WaitGroup |
| 134 | + respCh := make(chan workerResponse, numConReqs) |
| 135 | + conReqTime, _ := timeExecution(func() error { |
| 136 | + for i := 0; i < numConReqs; i++ { |
| 137 | + wg.Add(1) |
| 138 | + go func(id int) { |
| 139 | + defer wg.Done() |
| 140 | + err := sendFn() |
| 141 | + respCh <- workerResponse{id: id, err: err} |
| 142 | + }(i) |
| 143 | + } |
| 144 | + |
| 145 | + wg.Wait() |
| 146 | + return nil |
| 147 | + }) |
| 148 | + |
| 149 | + maybeErrMessage := "" |
| 150 | + for i := 0; i < numConReqs; i++ { |
| 151 | + resp := <-respCh |
| 152 | + if resp.err != nil { |
| 153 | + maybeErrMessage += fmt.Sprintf("error #%d: %v\n", i, resp.err) |
| 154 | + } else { |
| 155 | + log.Printf("Worker #%d done", resp.id) |
| 156 | + } |
| 157 | + } |
| 158 | + |
| 159 | + if maybeErrMessage != "" { |
| 160 | + return fmt.Errorf("at least one concurrent request failed:\n%s", maybeErrMessage) |
| 161 | + } |
| 162 | + |
| 163 | + // Validate that the concurrent requests were handled faster than if all |
| 164 | + // the requests were handled serially, using the single request time |
| 165 | + // as a benchmark. The concurrent time should be less than half of the |
| 166 | + // time it would have taken to execute all requests serially. |
| 167 | + if conReqTime*2 > numConReqs*singleReqTime { |
| 168 | + return fmt.Errorf("function took too long to complete %d concurrent requests. %d concurrent request time: %s, single request time: %s", numConReqs, numConReqs, conReqTime, singleReqTime) |
| 169 | + } |
| 170 | + log.Printf("Concurrent request response time benchmarked, took %s for %d requests", conReqTime, numConReqs) |
| 171 | + return nil |
| 172 | +} |
0 commit comments